/*
* Licensed under the MIT License
* 
* Copyright (c) 2010 Kay Kreuning
* 
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* 
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
* 
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
* 
* http://code.google.com/p/as3hyvesapi
*/
package nl.hyvesstudio.oauth.signing
{
	/**
	 * Interface for OAuth signature methods.
	 * 
	 * @author Kay Kreuning
	 */
	public interface ISignatureMethod
	{
		/** Name of the signature method */
		function get methodName():String;
		
		/**
		 * Calculate the signature based on the specified parameters.
		 * 
		 * @param parameters Object holding all the parameters for the request
		 * @param endpoint URL to make OAuth requests for
		 * @param consumerSecret OAuth consumer secret
		 * @param tokenSecret Accesstoken secret
		 * @httpMethod HTTP method to send request over
		 * @return A signature based on the specified parameters
		 */
		function calculateSignature(parameters:Object, endpoint:String, consumerSecret:String, tokenSecret:String, httpMethod:String = "GET"):String;
	}
}